Classifying Unified API

The following table lists down the different categories under which unified API are classified.

Further, it also provides information about the main use(s) of API included in the respective categories.

Unified API Category Usage of the Included API
Attribute API

>Creating an attribute object

>Defining additional input parameters using the attribute keys.

>Deleting the attribute object

Application Context API

>Creating an application context object that defines the configuration settings that should be used by the licensing API calls made using that application context. An application context makes use of the attribute object.

>Initializing and allocating the necessary resources for the RMS licensing library.

>Deleting the application context.

Basic Licensing API

>Obtaining a license authorization from the License Manager. You can also pass additional attributes while obtaining a license authorization.

>Renewing the license authorization obtained from the License Manager.

>Releasing the license authorization associated with a login session.

Utility API

>Providing additional functionality for transferring and installing the licenses.

>Enforcing synchronization between the licensed application \ License Manager and SCC.

>Installing the License Revocation Request (LRR) and returning the License Revocation Acknowledgment (LRA).

>Uninstallation of licenses.

Query API

>Provides comprehensive information related to the feature, license, client, fingerprint, locking code, recipient, licensing library, application context, License Manager (server), cumulative trial information, License Manager pool, and lease job synchronization.

>Providing information about a login session.

Parsing API

>These API are used for decoding and viewing the license details.

Resource Cleanup API

> These API are used for cleaning the licensing library.

Callback API

>These API are used for registering the software vendor defined callbacks.

Identity API

>These API are used for performing identity-related operations, such as setting a username.

NOTE   For more information, refer to the Unified API section of the Sentinel RMS API Reference Guide.